Skip to content

Improve-profile-readme-docs - #45418

Closed
Janu17 wants to merge 1 commit into
github:mainfrom
Janu17:patch-1
Closed

Improve-profile-readme-docs#45418
Janu17 wants to merge 1 commit into
github:mainfrom
Janu17:patch-1

Conversation

@Janu17

@Janu17 Janu17 commented Aug 4, 2026

Copy link
Copy Markdown

Added detailed instructions and tips for managing a profile README, including prerequisites, formatting options, and examples.

Why:

Closes:

What's being changed (if available, include any code snippets, screenshots, or gifs):

Check off the following:

  • A subject matter expert (SME) has reviewed the technical accuracy of the content in this PR. In most cases, the author can be the SME. Open source contributions may require an SME review from GitHub staff.
  • The changes in this PR meet the docs fundamentals that are required for all content.
  • All CI checks are passing and the changes look good in the review environment.

@Janu17
Enhance managing your profile README documentation
ecc9535 
Added detailed instructions and tips for managing a profile README, including prerequisites, formatting options, and examples.
@welcome

welcome Bot commented Aug 4, 2026

Copy link
Copy Markdown

Thanks for opening this pull request! A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines.

@github-actions github-actions Bot added the triage Do not begin working on this issue until triaged by the team label Aug 4, 2026
@github-actions

github-actions Bot commented Aug 4, 2026

Copy link
Copy Markdown
Contributor

How to review these changes 👓

Thank you for your contribution. To review these changes, choose one of the following options:

A Hubber will need to deploy your changes internally to review.

Table of review links

Note: Please update the URL for your staging server or codespace.

The table shows the files in the content directory that were changed in this pull request. This helps you review your changes on a staging server. Changes to the data directory are not included in this table.

Source Review Production What Changed
account-and-profile/how-tos/profile-customization/managing-your-profile-readme.md

Key: fpt: Free, Pro, Team; ghec: GitHub Enterprise Cloud; ghes: GitHub Enterprise Server

🤖 This comment is automatically generated.

@gordonsteph1313-cloud

This comment was marked as spam.

Sign in to view
@Sharra-writes Sharra-writes added invalid This issue/PR is invalid and removed invalid This issue/PR is invalid labels Aug 9, 2026
@github-actions github-actions Bot closed this Aug 9, 2026
@Sharra-writes

Sharra-writes commented Aug 9, 2026

Copy link
Copy Markdown
Contributor

@Janu17 Thanks for taking the time to contribute to this project. For changes of this nature, we ask that you open an issue first so we can discuss the problem you're hoping to solve before starting work on an implementation. We also ask that you follow the pull request template when opening a pull request, to help clarify your intent. Please also take a look at our contributing docs for more info.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

triage Do not begin working on this issue until triaged by the team

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@Janu17 @gordonsteph1313-cloud @Sharra-writes